docs: add hyperparameter sweep recipes - #681
Open
B1aZer wants to merge 1 commit into
Open
Conversation
Grid, random, and Optuna recipes built on init(group=, config=), plus dashboard viewing, SQL querying of results, and delegating sweeps to coding agents. Includes a runnable example.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follows up on #657 and the discussion in #669, where @abidlabs suggested documenting sweep recipes rather than adding a first-class sweep API.
This adds:
docs/source/sweeps.md— recipes for grid search, random search, and Bayesian optimization via Optuna, all built on the existinginit(group=..., config=...)pattern; a section on viewing sweep results in the dashboard; a section on querying the best configuration over SQL (including that a run's group is stored under the_Groupkey in the config JSON); and a short section on delegating sweeps to coding agents, linking to the ML Agents guide.examples/sweep-recipes.py— runnable, dependency-free example with the grid and random recipes.Every snippet was run against a local install from
main, including the Optuna recipe. While validating the SQL recipe I found thatSELECT config ...comes back hex-encoded throughtrackio query— fix proposed separately in #680.Happy to adjust scope or tone — e.g. trim the Optuna section if external-library recipes don't belong in the docs.